Skip to content

[skip changelog] Update create-changelog action in release workflow #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 12, 2021

Conversation

silvanocerza
Copy link
Contributor

The new create-changelog version fixes a bug that caused the whole git log to be used as changelog.

@silvanocerza silvanocerza requested a review from per1234 February 12, 2021 09:42
@silvanocerza silvanocerza self-assigned this Feb 12, 2021
@per1234
Copy link
Contributor

per1234 commented Feb 12, 2021

Thanks @silvanocerza! What would you think about adding a v1 ref to arduino/create-changelog, then using that ref here instead of pinning the patch version. That way, this workflow (and any others) using the arduino/create-changelog action can automatically benefit from any new non-breaking releases of the action.

This approach is mentioned as best practices in the GitHub Actions docs:
https://docs.github.com/en/actions/creating-actions/about-actions#using-release-management-for-actions
They seem to lean toward using a tag for this, but also mention the option of using a branch instead (any Git ref can be used). I somewhat prefer the branch approach because I have always though of a tag as an immutable marker for a specific point in the commit history. I have seen a couple of prominent actions that use the branch approach (though certainly many others use tags):

@silvanocerza
Copy link
Contributor Author

Yeah, I like that. I'll push a v1 branch on the create-changelog repo and update this PR.

@silvanocerza silvanocerza force-pushed the scerza/update-create-changelog-action branch from 459f971 to 8ad7737 Compare February 12, 2021 10:40
@silvanocerza silvanocerza merged commit 09f7530 into main Feb 12, 2021
@per1234 per1234 deleted the scerza/update-create-changelog-action branch February 17, 2021 10:49
@per1234 per1234 added topic: infrastructure Related to project infrastructure type: imperfection Perceived defect in any part of project labels Sep 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: infrastructure Related to project infrastructure type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants